Pixel-Perfect Reports Widget

The Pixel-Perfect Reports widget enables you to embed the Pixel-Perfect Reports feature in an application.

Embeddable Sample

Important: This example is for testing purposes only.

• In production, you must use a qvToken instead of exposing an apiKey in the UI.
• The apiKey is private and should only be used for backend-to-backend communication.

<!-- Tag -->
<qrvey-pixel-builder settings="reportsConfig"></qrvey-pixel-builder>

<!-- Config -->
<script>
  var reportsConfig = {
    "apiKey": "<YOUR_PRIVATE_API_KEY>",
    "domain": "<DOMAIN>",
    "userId": "<USER_ID>",
    "appId": "<APP_ID>",
    "clientId": "<CLIENT_ID>", //Optional.
    "orgId": "org:0" // Optional. your relevant orgId

  };
</script>

<!-- Launcher -->
<script type="text/javascript" src="https://<YOUR_QRVEY_DOMAIN>/widgets-launcher/app.js"></script>

Production Deployment

• Use qvToken instead of apiKey.
• Pass sensitive values (appId, userId, clientId) securely using qvToken.
• Configure timezone, parameters, and UI options as needed for production.

Configuration Object

Property	Value	Required	Description
qvToken	String	Yes, if apiKey is not provided	Encrypted token used for secure authentication.
apiKey	String	Yes, if qvToken is not provided.	Your organization’s unique API key required to access the Qrvey platform.
domain	String	Yes	Base URL of your Qrvey instance.
appId	String	Yes	ID of the Qrvey application that contains the asset you want to embed.
userId	String	Yes	ID of the Qrvey Composer user account accessing this feature. Optional: You can alternately specify the user ID in a Qrvey session cookie.
clientid	String	No	Unique identifier for the tenant end user. Required for using the End User Personalization and Download Manager features. The clientid must be set to a unique value for each tenant end user.
timezone	Object	No	Overrides the time zone setting in Qrvey Admin Center. For more information, see timezone object.
reportId	String	No	Used to embed a specific report by ID. If omitted, this embeds the "browse all reports" page.
orgId	String	No	Organization ID for the end user. Used to pass organization context to other components.
orgs	Object Array	No	The orgs object to list users, defined per organization, in the Subscribe modal. The orgs object is ignored when the widget's orgId is set to "org:0".
email	String	No	Email of the clientId user. When passed in the qvToken, enables scheduling of exports and subscriptions.
showFormulasButton	Boolean	No	Shows (default) or hides the formula modal button in the toolbar.
showBucketsButton	Boolean	No	Shows (default) or hides the bucket modal button in the toolbar.
parameterValues	Object	No	Set the value of a Pixel-Perfect report parameter. This value overrides the default value set for the parameter. Pattern: { key1: value1, key2: value2 } Example: { parameterName: paramVal }.
defaultMode	String	No	Either "preview" or "design" (default). A value of "preview" enables users to embed the Pixel-Perfect Reports in preview mode.

Timezone

For more information, see Configuring Time Zone Settings.

Property	Value	Required	Description
offset	string	No	Time to offset by. Pattern: {"HH:MM" } Example: { "offset": "-1:00" }

Customization

The customization options for the Pixel-Perfect Reports allow you to hide the export options.

const widgetConfig = {
  domain: "my-domain.qrvey.com",
  qvToken: "mySecureToken",
  ...
  customization: {
    // Global elements to remove
    remove: [
      '*.qDownloadReport', //The Download option in Preview mode.
      '*.qScheduleOption', //The schedule button inside the download modal.
      '*.qSubscribeOption', //The Subscribe tab within the Download modal.
      '*.qSubscribeExternalUsers' //The option to add external users using the Enter key within the Subscribe tab.
    ]
  }
};